Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a short warning to the doc-frontpage #28791

Merged
merged 1 commit into from
Aug 22, 2018

Conversation

fredrikekre
Copy link
Member

@fredrikekre fredrikekre commented Aug 21, 2018

Add a short warning to the doc-frontpage if the docs are for an in-development version of Julia.

Example:

screenshot from 2018-08-21 12-03-16

are for an in-development version of Julia.
@fredrikekre fredrikekre added the docs This change adds or pertains to documentation label Aug 21, 2018
@fredrikekre fredrikekre requested a review from ararslan August 22, 2018 14:32
Copy link
Member

@ararslan ararslan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent idea! Looks really good.

io = IOBuffer()
release = isempty(VERSION.prerelease)
v = "$(VERSION.major).$(VERSION.minor)"
!release && (v = v*"-$(first(VERSION.prerelease))")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nbd but you can use *=

if !release
print(io,"""
!!! warning "Work in progress!"
This documentation is for an unreleased, in-development, version of Julia.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comma after "in-development" feels a little weird but I'm not whether it's actually right or wrong grammatically. Doesn't really matter.

@fredrikekre fredrikekre merged commit 85cc84f into master Aug 22, 2018
@fredrikekre fredrikekre deleted the fe/add-note-on-in-development-docs branch August 22, 2018 21:36
staticfloat pushed a commit that referenced this pull request Aug 24, 2018
are for an in-development version of Julia.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants